Workbench Design/WB Collection.iso/workbench werkzeuge/icon tools/iconinstaller/redistribution/iconinstaller.guide

Amigaguide Document | 1996-04-07 | 17KB | 334 lines

@database IconInstaller.guide
@$VER: 3.1
@author "Tom Ekstr
@(c) "1995 Tom Ekstr
@node "Main" "CONTENTS"
                 ICONINSTALLER 3.1
          Icon Installation/Management Tool
               Freely Distributable
           Copyright
 1995 Tom Ekstr
               All Rights Reserved
INTRODUCTION
" link "Intro"}  IconInstaller described
USAGE
" link "Usage"}  About IconInstaller operation
Basic
Usage
" link "BMode"}  Installing icons manually
Directory
" link "DMode"}  Installing whole drawers of icons
Script
" link "SMode"}  Using prewritten scripts
Configuration
" link "Config"}  Changing the settings
MISCELLANEOUS
" link "Misc"}  Legal issues and tidbits
Copyright
" link "Copy"}  Distribution
Disclaimer
" link "Disc"}  Read this at your own risk
 @{" 3.3. NewIcon Info     " link "NIInfo"}  To those unfamiliar with NewIcons
Author
" link "Author"}  How to contact me
@endnode
@node "Intro" "INTRODUCTION"
@toc "Main"
   1.   INTRODUCTION
IconInstaller is a tool to aid in icon management. The @{"basic operation" link "BMode"} of
IconInstaller is to copy the imagery from one icon to another. Both standard
icons and @{"NewIcons" link "NIInfo"} are supported, including conversion from standard icons
to NewIcons, and vice versa. IconInstaller can also be used to copy other
attributes (such as tooltypes, position, default tool etc.) in addition to,
or instead of, the imagery.
IconInstaller has a mouse-driven graphical user interface, where icons can
be selected with simple dragging and dropping, or alternatively using
standard ASL file requesters. Unique to IconInstaller is a @{"script mode" link "SMode"},
where icons are selected for installation according to a script.
IconInstaller can also be used to easily @{"install whole drawers" link "DMode"} of icons
with a single command.
IconInstaller requires at least AmigaDOS release 2.04. No special libraries
are required. NewIcon.library, if found, is used for extra functionality.
For legal information, read the sections about @{"copyright" link "Copy"} and @{"disclaimer" link "Disc"}.
This is the 'light' version of the documentation, intended for inclusion
with IconInstaller in freely distributable icon collections. The full
version, that includes information about writing IconInstaller scripts
along with complete reference sections, is available in the original
IconInstaller distribution, eg. on Aminet in the 'util/wb' directory.
@endnode
@node "Usage" "USAGE"
@toc "Main"
   2.   USAGE
IconInstaller is a very versatile tool, and can be used in many different
ways. There is a normal mode for installing icons one by one, a directory
mode for installing whole drawers of icons, and a script mode for selecting
icons for installation according to a script.
In its basic configuration, IconInstaller will copy the image from one icon
to another, but also other icon attributes, such as default tool, icon type,
position, etc., can be selected for installation. @{"NewIcon" link "NIInfo"} users can
also change the configuration to copy NewIcon images, and convert between
standard icons and NewIcons.
Basic
Usage
" link "BMode"}  Installing and deleting icons manually
Directory
" link "DMode"}  Installing to drawers
Script
" link "SMode"}  Using a script to install icons
Configuration
" link "Config"}  Changing the settings
@endnode
@node "BMode" "USAGE"
@toc "Usage"
   2.1. BASIC USAGE
Start IconInstaller with a double click on its icon.
If you are using the @{"NewIcons" link "NIInfo"} system, a requester may appear asking you to
select from some image installation options.
IconInstaller will start as 'empty', with no icons selected. To install the
image from one icon to another, you'll need to open a source icon and a
destination icon. The easiest way to open an icon is to drag and drop it
into the IconInstaller window. Source icons can be dropped in the box
labeled 'New Image', destination icons in the box labeled 'Original Image'.
You can also open icons using a file requester. Select 'Open Source Icon...'
'Open Destination Icon...', respectively, from the 'Project' menu.
Finally, the destination icon can also be opened by typing its name into the
gadget labeled 'Destination Icon'.
When both source and destination icons are opened, you can click on the
'Install' gadget to replace the original image of the destination icon with
the new one from the source. If you prefer using menus, you can also select
'Install Icon' from the 'Project' menu.
IconInstaller can also be used to delete icons from files, leaving the file
associated with the icon intact. To delete an icon, open it as the
destination icon as described above. Then, select 'Delete icon...' from the
'Project' menu. IconInstaller will display a requester asking you to confirm
this action.
IconInstaller is also able to install multiple icons in one go, either a
whole @{"directory" link "DMode"} at once, or according to a @{"script" link "SMode"}.
Furthermore, you can @{"configure" link "Config"} the installation by selecting other icon
attributes to install from one icon to another, in addition to (or instead
of) the imagery, as well as change some other options.
@endnode
@node "DMode" "USAGE"
@toc "Usage"
   2.2. DIRECTORY MODE
Please read first the section describing @{"basic
usage" link "BMode"} of IconInstaller,
where opening source and destination icons is explaned, before proceeding
with this section.
To start directory installation, open both source and destination icons.
Then, click on the 'Dir' gadget. A requester will appear, asking for the
directory (drawer) where the installation should take place. By default, this
is the directory where the destination icon is located.
IconInstaller will read the icons in the directory, one by one, and open
each icon in its turn as the destination icon. For each icon, you can select
to install the image from the source icon, or skip the icon and move on to
the next one. Click on 'Install' or 'Skip' to make your choice. This process
is repeated for all icons in the directory.
You can instruct IconInstaller to complete the directory without further
interaction by clicking on the 'All' gadget. A requester will appear, asking
you to confirm this option.
You can also click on the 'Quit' gadget at any point, to abort the directory
installation.
The 'Settings' menu contains options to change the behaviour of directory
installation. The options can be changed by setting and clearing subitems
for the 'Directory' menuitem. The options available are 'Match Type',
'Create Icons' and 'Enter Directories'.
Match Type will accept for installation only those icons that are of the
same type as the source icon.
Create Icons will give you the option to create icons for files that don't
have icons.
Enter Directories means that the installation will proceed not only in this
directory, but all its subdirectories as well.
@endnode
@node "SMode" "USAGE"
@toc "Usage"
   2.3. SCRIPT MODE
Using IconInstaller in script mode is actually the easiest way to use it.
You don't even have to open icons for installation, as they are selected
automatically by the script.
You start a script by double clicking on the script's icon.
If you are using the @{"NewIcons" link "NIInfo"} system, a requester may appear asking you
to select from some options relating to the imagery installation.
The IconInstaller window will be opened as usual. IconInstaller will start
to open source and destination icons according to the script, presenting you
the new image from the source icon, and the original image of the
destination icon, side by side, before the installation. You can click on
these images to see the alternate imagery, if there is any.
For each icon you can select if you want to install the new image to the
destination icon, or keep the original image. Click on 'Install' or 'Skip',
respectively, to make your choice. IconInstaller will then open the next
source and destination icons according to the script. This process is
repeated for each pair of icons, until the script is complete.
As in the @{"directory
mode" link "DMode"}, you can instruct IconInstaller to complete the
script without further interaction, by clicking on the 'All' gadget. A
requester will appear asking you to confirm that you really want to do this.
You can also click on the 'Quit' gadget at any point, to abort the script
and reset IconInstaller to @{"basic
usage" link "BMode"}.
Depending on the script, you may also be presented with messages and
requesters either to give you information, or prompt you to select from
some available options.
@endnode
@node "Config" "USAGE"
@toc "Usage"
   2.4. CONFIGURATION
In its default configuration, IconInstaller will copy the imagery from one
icon to another, while retaining the other attributes of the destination
icon, such as tooltypes, default tool, position, and so on. If you have the
@{"NewIcons" link "NIInfo"} patch running, the default action is to copy the NewIcon image,
while keeping the standard image as it is.
While using IconInstaller, the configuration can be changed from the
'Settings' menu. The menu contains options for changing the 'Image',
'NewIcon' imagery, 'Icon Type', 'Default Tool', 'Tool Types', 'Position'
and 'Stack'.
All of these attribute settings contain at least two options, 'Keep Original'
and 'Copy From Source'. The former means that the attribute in the destination
icon is not changed, the latter means that the attribute is copied from the
source icon to the destination icon.
The 'Image' and NewIcon settings also contain options to convert imagery from
standard to NewIcon format, and vice versa. The 'Icon Type' and 'Default
Tool' settings contain many options to set the attribute explicitely.
In addition to the attribute settings,  the 'Settings' menu also includes
directory options to affect the behaviour of @{"directory installation" link "DMode"}.
Finally, there is an option to quickly install icons as soon as they are
dragged and dropped into the IconInstaller window, without having to click
on the 'Install' gadget.
The 'Settings' menu can be disabled with the NOSETTINGS tooltype, as
described below.
The default configuration can be changed with tooltypes in the IconInstaller
icon, so that every time you start IconInstaller, your preferred
configuration is active. To change the default configuration for a script,
tooltypes in the script's icon should be set instead.
The available tooltypes for changing the configuration are IMAGE (with the
options KEEP, COPY, NEWICON and DOT), NEWICON (KEEP, COPY, IMAGE, REMAP,
ERASE), ICONTYPE (KEEP, COPY, DISK, DRAWER, TOOL, PROJECT, TRASHCAN, KICK),
DEFTOOL (KEEP, COPY, TOOL1, TOOL2, TOOL3, TOOL4, OTHERTOOL), TOOLTYPES
(KEEP, COPY), POSITION (KEEP, COPY, FREE) and STACK (KEEP, COPY).
The TOOL1, TOOL2, TOOL3 and TOOL4 can be used to specify alternative tools
for 'MultiView, 'AmigaGuide', 'Display' and 'More', respectively.
OTHERTOOL can also be specified. The remaining tooltypes are ASKNEWICONS
(ask imagery installation options from NewIcon users), SIMPLEREFRESH (open
window as SimpleRefresh instead of SmartRefresh) and NOSETTINGS (disable
the 'Settings' menu).
@endnode
@node "Misc" "MISCELLANEOUS"
@toc "Main"
   3.   MISCELLANEOUS
This section contains legal information, some information about NewIcons,
and about the author, too.
  @{" 3.1. Copyright            " link "Copy"}
  @{" 3.2. Disclaimer           " link "Disc"}
  @{" 3.3. NewIcon Information  " link "NIInfo"}
  @{" 3.4. Author               " link "Author}
@endnode
@node "Copy" "MISCELLANEOUS"
@toc "Misc"
   3.1. COPYRIGHT
IconInstaller is freely distributable and copyright
 1995 by Tom Ekstr
There is no charge for using this software. This is generally known as
FreeWare.
This is the 'light' version of the documentation. This probably means that
this documentation was included with a freely distributable icon collection
along with IconInstaller. Icon authors who want to redistribute IconInstaller
with their icon collections are advised first to get the original full
archive, obtainable from eg. Aminet, in the 'util/wb' directory.
It is not permitted to distribute IconInstaller without this accompanying
documentation.
IconInstaller can be distributed in two ways:
1. As the complete IconInstaller archive.
   The original archive must be distributed in its entirety, without
   additions, deletions or modifications of any kind. The original archive
   contains the following files:
      IconInstaller              IconInstaller.info
      IconInstaller.guide        IconInstaller.guide.info
      Install_Icons              Install_Icons.guide
      Icons.info                 Icons/def_harddisk.info
      Icons/def_preset.info      Icons/def_ramdisk.info
      Icons/IGfx_Palette         Icons/IGfx_Palette.info
      Icons/PrefsDrawer          Icons/PresetDrawer
      Icons/Font.info            Icons/IControl.info
      Icons/Input.info           Icons/Locale.info
      Icons/Overscan.info        Icons/Palette.info
      Icons/Pointer.info         Icons/Printer.info
      Icons/PrinterGfx.info      Icons/PrinterPS.info
      Icons/ScreenMode.info      Icons/Serial.info
      Icons/Sound.info           Icons/Time.info
      Icons/WBPattern.info       Redistribution.info
      Redistribution/IconInstaller.guide
      Redistribution/IconInstaller.guide.info
2. As an installation tool with icon collections.
   Icon authors may include IconInstaller with their freely distributable
   icon collections. In this case, the following files must be included:
      IconInstaller         IconInstaller.guide
      IconInstaller.info    IconInstaller.guide.info
   It is recommended that the 'light' version of IconInstaller.guide from
   the 'Redistribution' drawer is included instead of the full version, as
   most people probably won't need the script writing and reference sections
   anyway.
   Optionally, the icon for the script ('Install_Icons.info') may be
   included as well. Tool types in the icon files may be changed, otherwise
   the files may not be altered in any way.
   As said before, IconInstaller may not be distributed separately from its
   documentation (IconInstaller.guide or Redistibution/IconInstaller.guide)
   under any circumstances.
In addition, the following two conditions must be met:
No profit may be made for distributing IconInstaller. A reasonable handling
and copying charge is acceptable.
No part of IconInstaller may be included in a commercial product without
my prior written consent. No prior permission is required to distribute
IconInstaller on Internet/FTP (ie. Aminet), public access BBS's, FidoNet,
and the Aminet, Fish series and other CD-ROMs containing only freely
distributable software. IconInstaller can also be included on a magazine
coverdisk, provided that a copy of that particular issue is sent to me.
If you want to send any feedback, complaints, bug reports etc., feel free
to send @{"me" link "Author"} a note.
@endnode
@node "Disc" "MISCELLANEOUS"
@toc "Misc"
   3.2. DISCLAIMER
THE AUTHOR MAKES NO WARRANTIES, EITHER EXPRESSED OR IMPLIED, WITH
RESPECT TO THE PROGRAM DESCRIBED IN THIS DOCUMENTATION, ITS QUALITY,
PERFORMANCE OR FITNESS FOR ANY PARTICULAR PURPOSE. THE PROGRAM IS
DISTRIBUTED "AS IS". THE ENTIRE RISK AS TO ITS QUALITY AND PERFORMANCE
IS WITH THE USER. IN NO EVENT WILL THE AUTHOR BE LIABLE OF DIRECT,
INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGE TO OR LOSS OF DATA OR
EQUIPMENT RESULTING FROM THE USE OF THIS PROGRAM.
@endnode
@node "NIInfo" "MISCELLANEOUS"
@toc "Misc"
   3.3. NEWICON INFORMATION
NewIcons is a new standard of icon (.info) files that makes icons look
good independently of the Workbench palette. This is accomplished by
including new icon imagery with colour data in the icon tooltypes, and
using a system patch to read this NewIcon imagery and display it instead
of the standard icon image. When the patch is in use, the NewIcon image
information is also hidden from the icon tooltypes.
In other words, NewIcons contain both standard and NewIcon imagery. When
the patch is not in use, the standard imagery is displayed as usual.
Because the NewIcon images contain colour information, they are remapped
to the current Workbench screen colours, and will therefore look good
on a screen with any palette.
To be able to use NewIcons, you'll need the NewIcons patch and the
accompanying newicon.library. These are included in the NewIcons package.
The package is not included with IconInstaller, but can be obtained from
eg. Aminet (pix/icon/NewIcons.lha), as well as good PD/Shareware suppliers.
The NewIcons standard is developed by Nicola Salmoria.
@endnode
@node "Author" "MISCELLANEOUS"
@toc "Misc"
   3.4. ICONINSTALLER AUTHOR
I'm currently studying at Tampere university in Finland, majoring in Library
and Information science.
I can be reached by
Mail   : Tom Ekstr
         Tiilentekij
nkatu 16 as.10
         FIN-20810 Turku
         FINLAND (Europe)
E-mail : [e-mail]
I reply to all e-mail I get. The e-mail address will be valid until autumn
1996, the street address is valid long into the future.
@endnode